Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerCreateSpec

Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerCreateSpec defines parameters for creating a Foundation Load Balancer.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "vip_ranges": [
        {
            "address": "string",
            "count": 0
        }
    ],
    "vip_subnets": [
        "string"
    ],
    "interfaces": [
        {
            "personas": [
                "string"
            ],
            "network": "string"
        }
    ],
    "deployment_target": {
        "zones": [
            "string"
        ],
        "storage_policy": "string",
        "deployment_size": "string",
        "availability": "string"
    },
    "network_services": {
        "dns": {
            "servers": [
                "string"
            ],
            "search_domains": [
                "string"
            ]
        },
        "ntp": {
            "servers": [
                "string"
            ]
        },
        "syslog": {
            "endpoint": "string",
            "certificate_authority_pem": "string"
        }
    }
}

array of Vcenter NamespaceManagement Supervisors Networks Edges IPRange

vip_ranges

Required

Virtual IP addresses assigned to Kubernetes load balancer services, which allow ingress into the Supervisor.

This property was added in vSphere API 9.0.0.0.

array of string

vip_subnets

Optional

Subnets to service Virtual IP addresses.

If any of the IP Addresses provided as part of Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerCreateSpec.vip_ranges falls outside the frontend network subnet, then you must supply corresponding subnet(s) for those IP addresses.

The load balancer nodes are configured with additional routing rules for the provided Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerCreateSpec.vip_subnets that ensure return traffic for client requests coming from a source IP addresses that fall under Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerCreateSpec.vip_subnets ranges get forwarded to frontend network gateway via frontend network interface instead of the workload network gateway.

Subnet values should be in their canonical subnet CIDR form (e.g. 192.168.0.0/24).

This property was added in vSphere API 9.0.0.0.

if unset no additional routing rules are setup on load balancer nodes.

array of Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerNetworkInterface

interfaces

Optional

Customize the network interfaces of the load balancer granting them roles based on your network topology requirements.

All three personas must be used. Up to three network interfaces may be configured.

For Persona properties see Vcenter NamespaceManagement Networks Edges Foundation Persona

This property was added in vSphere API 9.0.0.0.

If no interfaces are configured, then the load balancer will be attached to the Supervisor's management and workload networks when applicable.

If a Supervisor is provisioned with two networks, the following interface profile is created:

Interface IndexPersona(s)Network 1Management PersonaSupervisor Management Network 2Workload Persona, Frontend PersonaSupervisor Workload Network

In this context management traffic is isolated from workload and load balancer traffic.

If a Supervisor is provisioned with one network, the following interface profile is created.

Interface IndexPersona(s)Network 1Management Persona, Workload Persona, Frontend PersonaSupervisor Workload Network

In this context a single network interface is used for management, workload, and load balancer traffic.

deployment_target

Optional

Customize the placement of the Load Balancer.

This property was added in vSphere API 9.0.0.0.

If missing or null, the load balancer will be placed using its default configuration. See fields in Vcenter NamespaceManagement Networks Edges Foundation DeploymentTarget for a description of each default configuration.

network_services

Optional

Configure network services for this load balancer. Network services increase the reliability of your load balancer.

Network services must be accessible from a network interface with a Management Persona assigned.

This property was added in vSphere API 9.0.0.0.

If missing or null, and the interface configured with a Management Persona is connected to a DHCP network, it will attempt to obtain its settings from a DHCP server. If the interface configured with a Management Persona is connected to a static IP network, the values will be synced with the Supervisor's management services Vcenter NamespaceManagement Supervisors Networks Workload Network.services.

Availability of your load balancer may be reduced if network services are not configured. Therefore, it is highly recommended you ensure that network services are configured for your load balancer.